Skip to content

docs: terminology from passphrase to encryption password for managed encryption - #2102

Open
gaurav-goswamii wants to merge 5 commits into
getodk:masterfrom
gaurav-goswamii:docs/encryption-password
Open

docs: terminology from passphrase to encryption password for managed encryption#2102
gaurav-goswamii wants to merge 5 commits into
getodk:masterfrom
gaurav-goswamii:docs/encryption-password

Conversation

@gaurav-goswamii

@gaurav-goswamii gaurav-goswamii commented Sep 4, 2026

Copy link
Copy Markdown
Contributor

Closes #2070

Summary

Updates the documentation terminology for Project Managed Encryption features to use "encryption password" instead of "passphrase" for consistency and clarity.

Changes Made

  • docs/central-encryption.rst: Updated user documentation guides to refer to "encryption password" and "encryption password hint" for project managed encryption.
  • docs/_static/api-spec/central.yaml: Updated endpoint descriptions and feature overviews related to project managed encryption in the OpenAPI specification.
  • Intended Scope: Kept backup encryption terminology ("passphrase") untouched in central-backup.rst and system backup endpoints.

Verification

  • Documentation build verified using make autobuild.

@gaurav-goswamii

Copy link
Copy Markdown
Contributor Author

Closes #2070

@lognaturel lognaturel left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! A couple of change requests inline.

---------------------------

By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store. If you already have or plan to collect many files, storing them outside the main database can reduce database load and cost. It can also make it more practical to backup and restore the database.
By default, Central stores form and submission attachments in its main database, but it can be configured to move these to an external object store.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like an unrelated change.

@@ -490,7 +490,7 @@ info:
* `POST /projects/…/key` to enable project managed encryption.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The API docs are managed in the central-backend repo and copied over for rendering, please revert the change to central.yaml. In this case, let's not make the change at all in the API docs, the usage is clear enough for the more technical audience those docs target.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

For managed encryption, change "passphrase" to "encryption password"

2 participants